šŸ” API de AutenticaĆ§Ć£o - DocumentaĆ§Ć£o Completa

šŸ“‹ VisĆ£o Geral

A API de AutenticaĆ§Ć£o Ć© responsĆ”vel por toda a gestĆ£o de autenticaĆ§Ć£o e autorizaĆ§Ć£o no sistema CordenaAi, incluindo login, registro de usuĆ”rios, recuperaĆ§Ć£o de senha, confirmaĆ§Ć£o de email, validaĆ§Ć£o de tokens JWT e integraĆ§Ć£o com o sistema de corresponsĆ”veis. O sistema utiliza ASP.NET Core Identity com JWT para autenticaĆ§Ć£o segura.

šŸŽÆ Endpoints DisponĆ­veis

1. POST /api/autenticacao/token

Obter Token JWT

2. POST /api/autenticacao/login

Login Completo

3. GET /api/autenticacao/validar-token

Validar Token JWT

4. POST /api/autenticacao/registrar

Registrar Novo UsuƔrio

5. POST /api/autenticacao/verificar-convite-pendente

Verificar Convite Pendente

6. GET /api/autenticacao/verificar-token-convite/{tokenConvite}

Verificar Token de Convite

7. POST /api/autenticacao/registrar-com-convite

Registrar com Convite

8. GET /api/autenticacao/confirmar-email

Confirmar Email

9. POST /api/autenticacao/forgot-password

Solicitar RecuperaĆ§Ć£o de Senha

10. POST /api/autenticacao/reset-password

Redefinir Senha

11. GET /api/autenticacao/reset-password

PĆ”gina de RedefiniĆ§Ć£o de Senha

šŸ”§ Modelo de Dados

Estrutura do LoginRequest

{
  "userName": "string",
  "password": "string",
  "tipo": "user" | "app"
}

Estrutura do CriarUsuarioRequest

{
  "userName": "string",
  "email": "string",
  "password": "string",
  "nome": "string",
  "nomeSocial": "string",
  "cpf": "string",
  "celular": "string",
  "genero": "string",
  "dataNascimento": "datetime",
  "foto": "string",
  "aceiteReceberComunicado": "boolean",
  "aceiteTermosLgpd": "boolean",
  "status": "string",
  "dataCadastro": "datetime",
  "dataAtualizacao": "datetime"
}

Estrutura do LoginResult

{
  "status": "boolean",
  "message": "string",
  "token": {
    "token": "string",
    "dtEmissao": "datetime",
    "dtExpiracao": "datetime"
  },
  "usuario": {
    "id": "string",
    "nome": "string",
    "email": "string",
    "userName": "string",
    "cpf": "string",
    "celular": "string",
    "status": "string"
  }
}

šŸ” AutenticaĆ§Ć£o e AutorizaĆ§Ć£o

Tipos de AutenticaĆ§Ć£o

PermissƵes por Endpoint

šŸ“Š Casos de Uso Principais

1. Fluxo de Login

POST /api/autenticacao/login
Content-Type: application/json

{
  "userName": "[email protected]",
  "password": "senha123",
  "tipo": "user"
}

2. Fluxo de Registro

POST /api/autenticacao/registrar
Content-Type: application/json

{
  "userName": "[email protected]",
  "email": "[email protected]",
  "password": "senha123",
  "nome": "Novo UsuƔrio",
  "cpf": "12345678901",
  "celular": "11999999999"
}

3. Fluxo de RecuperaĆ§Ć£o de Senha

POST /api/autenticacao/forgot-password
Content-Type: application/json

{
  "email": "[email protected]"
}

4. Fluxo de RedefiniĆ§Ć£o de Senha

POST /api/autenticacao/reset-password
Content-Type: application/json

{
  "userId": "user-id",
  "code": "verification-code",
  "newPassword": "novaSenha123"
}

āš ļø ValidaƧƵes e Regras de NegĆ³cio

ValidaƧƵes ObrigatĆ³rias

Regras de NegĆ³cio

šŸšØ Tratamento de Erros

CĆ³digos de Status HTTP

Formato de Erro

{
  "error": "string",
  "message": "string",
  "details": "string",
  "timestamp": "datetime"
}

šŸ“ˆ Performance e LimitaƧƵes

LimitaƧƵes

OtimizaƧƵes

šŸ”„ IntegraĆ§Ć£o com Outros MĆ³dulos

MĆ³dulos Relacionados

šŸ“± Uso em AplicaƧƵes

Web App

Mobile App

API Externa

šŸ› ļø ManutenĆ§Ć£o e Monitoramento

Logs Importantes

MĆ©tricas Monitoradas

šŸ“š Exemplos PrĆ”ticos

Fluxo Completo de Registro

  1. ValidaĆ§Ć£o de dados no backend pela prĆ³pria API
  2. POST /api/autenticacao/verificar-convite-pendente para verificar convites
  3. POST /api/autenticacao/registrar com dados validados
  4. Envio de email de confirmaĆ§Ć£o automĆ”tico
  5. GET /api/autenticacao/confirmar-email para ativar conta
  6. POST /api/autenticacao/login para primeiro acesso

Fluxo de RecuperaĆ§Ć£o de Senha

  1. POST /api/autenticacao/forgot-password com email
  2. Envio de email com link de recuperaĆ§Ć£o
  3. GET /api/autenticacao/reset-password para acessar pƔgina
  4. POST /api/autenticacao/reset-password com nova senha
  5. POST /api/autenticacao/login com nova senha

IntegraĆ§Ć£o com CorresponsĆ”veis

  1. VerificaĆ§Ć£o de convite antes do registro
  2. Registro com associaĆ§Ć£o automĆ”tica ao corresponsĆ”vel
  3. NotificaĆ§Ć£o ao corresponsĆ”vel sobre novo usuĆ”rio
  4. AtivaĆ§Ć£o da relaĆ§Ć£o corresponsĆ”vel-atleta

VersĆ£o: 1.0
ƚltima AtualizaĆ§Ć£o: Outubro de 2025
ResponsƔvel: Equipe de Desenvolvimento CordenaAi